home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr47 / wasm223.zip / SESSION.DOC < prev    next >
Text File  |  1993-05-04  |  12KB  |  310 lines
  1.  
  2.  
  3.                      SESSION
  4.                   By Eric Tauck
  5.                  October 2, 1990
  6.  
  7.      Session is    a simple yet capable communications program.  Some of the
  8.      features of Session include text and binary file transfers, a DOS
  9.      shell, ANSI terminal emulation, and a macro language.  Session works
  10.      well for connecting to online services and    BBS's.
  11.  
  12.      Session is    primarily configured with command line parameters.  The
  13.      idea is to    have a batch file or menu system run Session with the
  14.      proper parameters and log-on macro.
  15.  
  16.                   Command Line Options
  17.                   --------------------
  18.  
  19.      All command line parameters must be separated by one or more spaces.
  20.      Configuration options consist of a    slash, a letter, and a number.    If
  21.      the name of a macro file is present on the    command    line, the macro
  22.      will automatically    be compiled and    executed.
  23.  
  24.      /Bnnnn  Baud rate (actually bits per second).  Most modems    work at
  25.          300, 1200,    or 2400    bps.  I    think the maximum reliable speed
  26.          using this    software is 19200 bps.    On some    hardware I have    had
  27.          some trouble with a direct    serial link using this software    at
  28.          above 2400    bps.  The default is /B2400.
  29.  
  30.      /Cn     Color.  This option forces    Session    to use the color or black
  31.          and white attribute sets.    Use /C0    to let Session choose, /C1
  32.          to    force the color    attribute set, or /C2 to force the b/w
  33.          attribute set.  The default is /C0.
  34.  
  35.      /Dn     Serial port data bits.  Use /D7 for 7 data    bits or    or /D8 for
  36.          8 data bits.  The default is /D8.
  37.  
  38.      /Nn     Noise.  This option will silence Session if you don't like
  39.          any noise.     Use /N0 for no    noises or /N1 to enable    noises.
  40.  
  41.      /Onnnn  Options.  The values below    must be    added together to enable
  42.          the desired features.  For    instance, /O33 will enable local
  43.          echo and high bit stripping (1 + 32).  If the /O parameter    is
  44.          used, any option not explicitly enabled is    disabled.  For
  45.          instance, though ANSI is enabled by default, specifying /O33
  46.          will turn ANSI support off.  If you set any /O option, you
  47.          must set ALL the /O options you want enabled.
  48.  
  49.           1  Local echo.  All characters typed locally will be
  50.              echoed to the display.  GEnie needs this option.
  51.  
  52.           2  Split screen.  The    screen will be divided in in two.
  53.              All incoming characters will be displayed in the upper
  54.              half and all characters typed locally will    be
  55.              displayed in the lower half.
  56.  
  57.          16  Append LF to CR.  A linefeed will be displayed after
  58.              every incoming carriage return.  This is particularly
  59.              useful for    direct micro-to-micro chatting in split
  60.              screen mode.
  61.  
  62.  
  63.          32  Strip high    bit.  The upper    bit of all incoming bytes
  64.              is    cleared.  This should clear up the scrambled prompt
  65.              you might get just    before logging on to Compuserve    or
  66.              GEnie.
  67.  
  68.          64  Fast xmodem.  Use this option when    connecting directly
  69.              to    other micros or    BBS's.    Do not use this    option when
  70.              connecting    to timesharing systems (like GEnie and
  71.              Compuserve).  This    option is on by    default.
  72.  
  73.         128  1K    xmodem.     Allows    data to    be sent    and received using
  74.              1024 byte xmodem blocks.  This protocol is    usually    a
  75.              little faster than    regular    xmodem but not all systems
  76.              support it.
  77.  
  78.         256  Enable ANSI.  Allows the remote system to control the
  79.              screen using ANSI sequences.  It usually doesn't hurt
  80.              to    have ANSI enabled, even    if the remote system
  81.              doesn't use ANSI sequences.  This option is on by
  82.              default.
  83.  
  84.         512  Detect loss of carrier.  Session will beep    and display
  85.              a message whenever    the carrier is lost.  Losing the
  86.              carrier usually means the remote system is    no longer
  87.              connected.
  88.  
  89.            2048  Filter control characters.     Unsupported incoming
  90.              control characters    will not be displayed.    This
  91.              sometimes cuts down on the    garbage    displayed on the
  92.              screen when connecting or disconnecting at    2400 bps.
  93.              This option is on by default.
  94.  
  95.            8192  Enable macro debugging.  When enabled, every time a
  96.              macro is started or a BREAK or QUIT is encountered
  97.              within a macro, the current location in the macro is
  98.              displayed and the top three items on the stack and
  99.              return stack are displayed.  You may then press ALT-B
  100.              to    disable    debugging or ALT-A to abort the    macro.    Any
  101.              other key allows the macro    to continue running with
  102.              debugging on.
  103.  
  104.      /Pn     Serial port number.  Use /P1 for serial port one or /P2 for
  105.          serial port two.  The default is /P1.
  106.  
  107.      /Rn     Serial parity.  Use /P0 for no parity, /P1    for odd    parity,    or
  108.          /P2 for even parity.  The default is /P0.
  109.  
  110.      /Sn     Serial stop bits.    Use /S1    for one    stop bit or /S2    for two
  111.          stop bits.     The default is    /S1.
  112.  
  113.      /Tnn    Text pacing.  This    option slows the rate at which text files
  114.          are sent by pausing at the    end of each line.  This    is
  115.          sometimes necessary when connecting to slow systems.  The time
  116.          is    specified in "ticks," which occur about    18.2 times a
  117.          second. The default is /T9    (about 1/2 second).
  118.  
  119.      /Vnn    Video mode.  Use the numbers below    to specify which text video
  120.          mode you wish to use.  The    mode descriptions list the number
  121.  
  122.  
  123.          of    columns    by the number of rows.    Note that the non-standard
  124.          modes (all    the modes except 80 x 25) require specific video
  125.          adapters.    The default mode is /V8025.
  126.  
  127.         8  80 x    12; VGA    color
  128.         9  80 x    14; VGA    color
  129.            10  80 x    21; VGA
  130.            11  80 x    25; all    adapters
  131.            12  80 x    28; VGA
  132.            13  80 x    43; EGA, VGA
  133.            14  80 x    50; VGA
  134.  
  135.                  Terminal Mode Commands
  136.                  ----------------------
  137.  
  138.      Session enters terminal mode upon execution.  All commands    are
  139.      immediately available.
  140.  
  141.      F1        Help screen.  This command displays    a one page summary of all
  142.         the    terminal commands.
  143.  
  144.      PgUp   Upload a binary file.  This    command    sends a    file using the
  145.         xmodem protocol.  The protocol can be adjusted from    the command
  146.         line when Session is started.
  147.  
  148.      PgDn   Download a binary file.  This command receives a file using    the
  149.         xmodem protocol.  The protocol can be adjusted from    the command
  150.         line when Session is started.
  151.  
  152.      ALT-A  Abort file transfer.  This command aborts (in order): a binary
  153.         file transfer, a text upload, or a text download.  Only one
  154.         thing is aborted at    a time,    but repeatedly pressing    this key
  155.         twill abort    all these things.
  156.  
  157.      ALT-B  Toggle macro debugging.  This command turns    debugging on if
  158.         it's off, or turns it off if it's on.  Macro debugging can also
  159.         be turned on or off    from the command line when Session is
  160.         started.
  161.  
  162.      ALT-C  Clear screen.  This    command    clears the screen.  In split screen
  163.         mode, both halves of the screen are    cleared.
  164.  
  165.      ALT-D  Download a text file.  This    command    captures incoming text to a
  166.         file.  If the file you specify already exists, the new text    is
  167.         appended to    its end.  You can stop downloading text    by pressing
  168.         ALT-A.
  169.  
  170.      ALT-E  Toggle echo.  This command turns echo on if    it's off, or turns
  171.         it off if it's on.    Echo can also be turned    on or off from the
  172.         command line when Session is started.
  173.  
  174.      ALT-M  Run    macro.    This command compiles and runs a macro.     If the
  175.         file you specify doesn't exist in the current directory and    DOS
  176.         3.0    or higher is running, Session will look    in the directory
  177.         where SESSION.COM resides.
  178.  
  179.      ALT-R  Reset screen.  Use this command to clear and reset the colors
  180.         of the screen when a remote    system has left    the screen in an
  181.  
  182.  
  183.         odd    state (by setting the colors with ANSI sequences).
  184.  
  185.      ALT-S  Toggle split screen.  This command splits the screen if it's
  186.         whole, or merges the screen    if it's    split.    Split screen mode
  187.         can    also be    turned on or off from the command line when Session
  188.         is started.
  189.  
  190.      ALT-U  Upload a text file.     This command sends a text file    to the
  191.         serial port.  The text is sent just    as if you had typed it.
  192.  
  193.      ALT-X  Exit program.  This    command    leaves the Session program.
  194.  
  195.      ALT-Z  System shell.  This    command    runs a DOS shell.  Running a DOS
  196.         shell doesn't affect the serial connection.
  197.  
  198.                  Macro Language
  199.                  --------------
  200.  
  201.      The macro language    comes from the WASM library and    is described in    the
  202.      Language Description section of the file MACRO.DOC.  The following    is a
  203.      description of the    Session    specific keywords added    to this    macro
  204.      language:
  205.  
  206.      CGET    - 0 | byte    -1
  207.  
  208.        Get a communications byte.  Return false    if no byte or true and a
  209.        byte if available.
  210.  
  211.      CLEAR
  212.  
  213.        Clear the screen.  The screen is    cleared    just like the clear screen
  214.        terminal    command    ALT-C.
  215.  
  216.      CPUT    byte -
  217.  
  218.        Send a communications byte.  The    byte is    sent directly, not through
  219.        the terminal.
  220.  
  221.      CREP    byte -
  222.  
  223.        Replace a communications    byte.  Simulates receiving a byte.  Can
  224.        only replace one    byte at    a time.
  225.  
  226.      DLOAD   file -
  227.  
  228.        Download    a file using xmodem.  The user is not prompted for a file
  229.        name, however overwrites    will be    verified as usual.
  230.  
  231.      ERROR   message -
  232.  
  233.        Display an error    message.  The error is displayed at the    top of the
  234.        screen, the speaker is beeped, and ESC must be pressed.
  235.  
  236.      INPUT   buffer prompt - 0 | -1
  237.  
  238.        Input a string to the buffer.  False is returned    if there is no
  239.        input.
  240.  
  241.  
  242.  
  243.      KGET    - 0 | key -1
  244.  
  245.        Get a keystroke.     Return    false an no byte or true and a byte if
  246.        available.
  247.  
  248.      KREP    key -
  249.  
  250.        Replace a keystroke.  Simulates pressing    a key.    Can only replace
  251.        one keystroke at    a time.
  252.  
  253.      MESS    message -
  254.  
  255.        Type a string to    the terminal screen.  The string is displayed in
  256.        the color of system messages and    an CR/LF is appended to    the end.
  257.  
  258.      RESET
  259.  
  260.        Reset the timer.     This keyword resets the timer used by the TICKS
  261.        keyword.
  262.  
  263.      TERM    byte -
  264.  
  265.        Send a byte through the terminal.  The byte is subject to being
  266.        echoed or otherwise processed by    the terminal.
  267.  
  268.      TICKS   - ticks
  269.  
  270.        Return time passed.  The    time since the last RESET is returned in
  271.        ticks.  Ticks occur about 18.2 times a second.
  272.  
  273.      TYPE    character -
  274.  
  275.        Type a character    to the terminal    screen.     The character is displayed
  276.        in the color of system terminal messages.
  277.  
  278.      ULOAD   file -
  279.  
  280.        Upload a    file using xmodem.  The    user is    not prompted for a file
  281.        name.
  282.  
  283.      VERIFY  message - 0 | -1
  284.  
  285.        Verify something.  The verify prompt is displayed and the user must
  286.        press Y for yes or N for    no.  False is returned if the result is    no.
  287.  
  288.      Macro debugging can be toggled on or off with the terminal    command
  289.      ALT-B or turned on    or off from the    command    line.  When macro debugging
  290.      is    on, the    state of the macro is displayed    whenever a macro starts, a
  291.      BREAK is encountered, or a    QUIT is    encountered.  The information
  292.      displayed is: the current location    in the macro, the number of items
  293.      on    the stack, the number of items on the return stack (from CALL's),
  294.      the top three items on the    stack, and the top three items on the
  295.      return stack.  The    stack items are    displayed three    different ways:    as
  296.      a signed decimal number, a    hexadecimal number, and    the nearest
  297.      previous symbol to    that address.  The nearest previous symbol is also
  298.      displayed for the current macro location.
  299.  
  300.      When a macro is interrupted and its state information displayed, the
  301.  
  302.  
  303.      debugger waits for    a keystroke.  You can press ALT-A to abort the
  304.      macro, ALT-B to disable debugging and continue, or    any other key to
  305.      continue with debugging still on.
  306.  
  307.      By    placing    BREAK statements at key    locations, you can determine
  308.      exactly what the macro is doing.  The best    way to write a macro is    to
  309.      write and test small parts    of it at at time.
  310.